Creating API Definitions

The API Definitions page shows the list of all API definitions. An API definition is a set of configurable properties that specify the function of an API within the Traffic Manager.

On the Cloud API Management dashboard's Get Started page, click API Definitions or navigate to Design > API to create a new API definition. You can create a new API definition by importing a file, importing from a URI, creating it manually, or importing from the Boomi Platform. Refer to the Procedure section on this page for more information on creating API definitions for each option.

After creating API definitions, you can create endpoints and method definitions for the API. Other API related settings can be configured on the API Definition Settings, API Definition Security Settings, API Definition Error Sets, and API Definition Access Control pages.

note

Only an Administrator or API Manager can access the API Definitions page. To view this page, ensure you are assigned to one of these roles for your area.

Procedure

1. On the Get Started page, click API Definitions.

   Or

   Navigate to Design > APIs. This opens the Manage your APIs with API Definitions page.

2. Click New API Definition and choose any one of the following options to create a new API definition:

   info

   • The Import a file, Import from URI, and Create Manually options allow you to create a new API definition within Cloud API Management.
   • The Import from Boomi Platform option allows you to create a new API definition for a deployed API Service from the Platform in Cloud API Management.

   • Import a file:

     • If importing an Open API file, refer to Importing Swagger API Definition File.

     • If importing a GraphQL file, refer to Importing GraphQL API Definition File.

   • Import from URI: If importing a GraphQL file from a URI, refer to Importing GraphQL API Definition from URI.

   • Create manually: If creating manually, refer to Creating API Definition manually.

   • Import API from Boomi Platform: If importing an API Service from Boomi Platform to Cloud API Management, refer to Importing API from Boomi Platform.

Next Steps

After creating API definitions, create endpoints and method definitions for the API. Refer to Creating an Endpoint Manually and Creating Methods for more information.